POST | https://[domain].deskie.io/api/users.json
{
"user" : {
"user_email" : "user@domain.com",
"user_full_name" : "User's full name",
"company_name" : "User's company name",
"company_position" : "User's position",
"user_note" : "Some note",
"language_id" : 2,
"custom_fields" : {
"cf_20" : "some data",
"cf_23" : true
}
}
}
{
"user" : {
"user_id" : 200,
"user_full_name" : "User's full name",
"company_name" : "User's company name",
"company_position" : "User's position",
"thumbnail" : "",
"confirmed" : false,
"active" : true,
"deleted" : false,
"created_at" : "Mon, 05 May 2014 00:15:17 +0300",
"updated_at" : "Tue, 23 Dec 2014 10:55:23 +0200",
"password" : "bsdegs",
"type" : "email",
"user_email" : "user@domain.com",
"language_id" : 2,
"custom_fields" : {
"cf_20" : "some data",
"cf_23" : true
},
"linked_users" : [123,456]
}
}
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X POST -d '{ "user": { "user_email":"user@domain.com", "user_full_name":"User\u0027s full name", "language_id":2, "custom_fields":{"cf_20":"some data", "cf_23":true} }}' https://[domain].deskie.io/api/users.json
GET | https://[domain].deskie.io/api/users.json
{
"0": {
"user" : {
"user_id" : 200,
"user_full_name" : "User's full name",
"company_name" : "User's company name",
"company_position" : "User's position",
"thumbnail" : "",
"confirmed" : false,
"active" : true,
"deleted" : false,
"created_at" : "Mon, 05 May 2014 00:15:17 +0300",
"updated_at" : "Tue, 23 Dec 2014 10:55:23 +0200",
"type" : "email",
"user_email" : "user@domain.com",
"language_id" : 2,
"custom_fields" : {
"cf_20" : "some data",
"cf_23" : true
}
}
},
"1": {
"user" : {
"user_id" : 300,
"user_full_name" : "Second user's full name",
"company_name" : "Second user's company name",
"company_position" : "Second user's position",
"thumbnail" : "",
"confirmed" : false,
"active" : true,
"deleted" : false,
"created_at" : "Mon, 05 May 2014 00:15:17 +0300",
"updated_at" : "Tue, 23 Dec 2014 10:55:23 +0200",
"type" : "facebook",
"facebook_id" : 123123123,
"language_id" : 2,
"custom_fields" : {
"cf_20" : "some data",
"cf_23" : true
}
}
},
"2": {
"user" : {
"user_id" : 400,
"user_full_name" : "Third user's full name",
"company_name" : "Third user's company name",
"company_position" : "Third user's position",
"thumbnail" : "",
"confirmed" : false,
"active" : true,
"deleted" : false,
"created_at" : "Mon, 05 May 2014 00:15:17 +0300",
"updated_at" : "Tue, 23 Dec 2014 10:55:23 +0200",
"type" : "twitter",
"facebook_id" : 3333333,
"language_id" : 1,
"custom_fields" : {
"cf_20" : "some data",
"cf_23" : true
}
}
},
"total_count":20
}
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -g -X GET "https://[domain].deskie.io/api/users.json?limit=50&page=2&language_id=2&custom_fields[cf_20]=data"
GET | https://[domain].deskie.io/api/users/[id].json
{
"user" : {
"user_id" : 200,
"user_full_name" : "User's full name",
"company_name" : "User's company name",
"company_position" : "User's position",
"thumbnail" : "",
"confirmed" : false,
"active" : true,
"deleted" : false,
"created_at" : "Mon, 05 May 2014 00:15:17 +0300",
"updated_at" : "Tue, 23 Dec 2014 10:55:23 +0200",
"type" : "email",
"user_email" : "user@domain.com",
"language_id" : 2,
"custom_fields" : {
"cf_20" : "some data",
"cf_23" : true
},
"linked_users" : [123,456]
}
}
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X GET https://[domain].deskie.io/api/users/200.json
PUT | https://[domain].deskie.io/api/users/[id].json
{
"user" : {
"user_full_name" : "User's full name changed",
"language_id" : 1,
"custom_fields" : {
"cf_20" : "some data",
"cf_23" : true
}
}
}
{
"user" : {
"user_id" : 200,
"user_full_name" : "User's full name changed",
"company_name" : "User's company name",
"company_position" : "User's position",
"thumbnail" : "",
"confirmed" : false,
"active" : true,
"deleted" : false,
"created_at" : "Mon, 05 May 2014 00:15:17 +0300",
"updated_at" : "Tue, 23 Dec 2014 10:55:23 +0200",
"type" : "email",
"user_email" : "user@domain.com",
"language_id" : 1,
"custom_fields" : {
"cf_20" : "some data",
"cf_23" : true
}
}
}
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X PUT -d '{ "user": { "user_full_name":"User\u0027s full name changed", "language_id":2, "custom_fields":{"cf_20":"some data", "cf_23":true} }}' https://[domain].deskie.io/api/users/200.json
POST | https://[domain].deskie.io/api/users/identification.json
{
"user" : {
"user_full_name" : "Jane Ostin",
"company_name" : "ABCompany",
"user_email" : "j.ostin@abcompany.com",
"user_phone" : "+442034867173",
"user_whatsapp_phone" : "+442034867173",
"user_custom_id" : "j.ostin",
"user_custom_channel" : "481",
"custom_fields" : {
"cf_7264" : "some data",
"cf_7786" : 2,
"cf_7486" : true
}
}
}
{
"code": "o_37BD49_uv"
}
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X POST -d '{ "user": { "user_email":"j.ostin@abcompany.com", "user_phone":"+442034867173", "user_full_name":"Jane Ostin", "custom_fields":{"cf_7264":"some data", "cf_7786":2, "cf_7486":true} }}' https://[domain].deskie.io/api/users/identification.json
PUT | https://[domain].deskie.io/api/users/[id]/link.json
{
"user_email" : "user@domain.com"
}
{
"user" : {
"user_id" : 1307386,
"user_full_name" : "User's full name",
"company_name" : "User's company name",
"company_position" : "User's position",
"thumbnail" : "",
"confirmed" : false,
"active" : true,
"deleted" : false,
"created_at" : "Mon, 05 May 2014 00:15:17 +0300",
"updated_at" : "Tue, 23 Dec 2020 10:55:23 +0200",
"language_id" : 2,
"custom_fields" : {
"cf_20" : "some data",
"cf_23" : true
},
"type" : "telegram",
"telegram_id" : 495582869,
"linked_users" : [1307386,25830712]
}
}
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X PUT -d '{"user_email":"user@domain.com"}' "https://[domain].deskie.io/api/users/25830712/link.json"
PUT | https://[domain].deskie.io/api/users/[id]/unlink.json
{
"user_id" : 25830712
}
{
"user" : {
"user_id" : 1307386,
"user_full_name" : "User's full name",
"company_name" : "User's company name",
"company_position" : "User's position",
"thumbnail" : "",
"confirmed" : false,
"active" : true,
"deleted" : false,
"created_at" : "Mon, 05 May 2014 00:15:17 +0300",
"updated_at" : "Tue, 23 Dec 2020 10:55:23 +0200",
"language_id" : 2,
"custom_fields" : {
"cf_20" : "some data",
"cf_23" : true
},
"type" : "telegram",
"telegram_id" : 495582869,
"linked_users" : [1307386]
}
}
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X PUT -d '{"user_id": 25830712}' "https://[domain].deskie.io/api/users/25830712/unlink.json"
PUT | https://[domain].deskie.io/api/users/[id]/disable.json
{
"user" : {
"user_id" : 200,
"user_full_name" : "User's full name changed",
"company_name" : "User's company name",
"company_position" : "User's position",
"thumbnail" : "",
"confirmed" : false,
"active" : true,
"deleted" : true,
"created_at" : "Mon, 05 May 2014 00:15:17 +0300",
"updated_at" : "Tue, 23 Dec 2014 10:55:23 +0200",
"type" : "email",
"user_email" : "user@domain.com",
"language_id" : 2,
"custom_fields" : {
"cf_20" : "some data",
"cf_23" : true
}
}
}
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X PUT -d '' https://[domain].deskie.io/api/users/200/disable.json
PUT | https://[domain].deskie.io/api/users/[id]/block.json
{
"user" : {
"user_id" : 200,
"user_full_name" : "User's full name changed",
"company_name" : "User's company name",
"company_position" : "User's position",
"thumbnail" : "",
"confirmed" : false,
"active" : false,
"deleted" : false,
"created_at" : "Mon, 05 May 2014 00:15:17 +0300",
"updated_at" : "Tue, 23 Dec 2014 10:55:23 +0200",
"type" : "email",
"user_email" : "user@domain.com",
"language_id" : 2,
"custom_fields" : {
"cf_20" : "some data",
"cf_23" : true
}
}
}
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X PUT -d '' https://[domain].deskie.io/api/users/200/block.json
PUT | https://[domain].deskie.io/api/users/[id]/restore.json
{
"user" : {
"user_id" : 200,
"user_full_name" : "User's full name changed",
"company_name" : "User's company name",
"company_position" : "User's position",
"thumbnail" : "",
"confirmed" : false,
"active" : true,
"deleted" : false,
"created_at" : "Mon, 05 May 2014 00:15:17 +0300",
"updated_at" : "Tue, 23 Dec 2014 10:55:23 +0200",
"type" : "email",
"user_email" : "user@domain.com",
"language_id" : 2,
"custom_fields" : {
"cf_20" : "some data",
"cf_23" : true
}
}
}
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X PUT -d '' https://[domain].deskie.io/api/users/200/restore.json
DELETE | https://[domain].deskie.io/api/users/[id].json
HTTP Status: 200 OK
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X DELETE https://[domain].deskie.io/api/users/200.json